home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / BBS-Archive / Comm / AmiTCP30b2.lha / doc / netinfo.doc < prev    next >
Text File  |  1994-05-20  |  9KB  |  231 lines
  1. TABLE OF CONTENTS
  2.  
  3. netinfo.device/--background--
  4. netinfo.device/group
  5. netinfo.device/passwd
  6. netinfo.device/--background--                   netinfo.device/--background--
  7.  
  8.    PURPOSE
  9.  
  10.        The netinfo.device is intended to access various information from
  11. network database.  It provides an uniform and well-defined interface
  12. to databases, so it is easy to adopt clients to different
  13. environments.  There is a separate unit for each database.
  14.  
  15.        Currently the netinfo.device supports access to local password and
  16. group files.  As a new feature since last release it supports file
  17. notification.
  18.  
  19. The device file is located to "AmiTCP:devs/netinfo.device".  It is
  20. recommended that the OpenDevice() call is given the macro NETINFONAME
  21. as device name.
  22.  
  23.    OVERVIEW
  24.        Short overview of implemented IO commands is as follows:
  25.  
  26.    CMD_RESET - reset sequential access
  27.        This command restarts the sequential database reading.
  28.        Inputs: none
  29.        Results:
  30.          * io_Error contains possaible error code or 0 if command was
  31.            successfull
  32.  
  33.    CMD_READ - read next entry
  34.        Inputs:
  35.          * io_Data contains buffer for database entry. The buffer will
  36.            be filled wtih entry data upon successfull execution.
  37.          * io_Length contains database len
  38.        Results:
  39.          * io_Actual contains length of the database entry
  40.          * io_Error contains possaible error code or 0 if command was
  41.            successfull
  42.  
  43.    CMD_WRITE - alter the database
  44.        This command adds a new database entry or replace an old entry.
  45.        If a matching entry with same name is found, it is replaced with
  46.        the new entry.
  47.  
  48.        Inputs:
  49.          * io_Data contains pointer for database entry structure
  50.        Results:
  51.          * io_Actual contains length of the database entry
  52.          * io_Error contains possible error code or 0 if command was
  53.            successfull
  54.  
  55.    CMD_UPDATE - copy the previous changes to permanent store
  56.  
  57. This command updates the permanent copies of database.  The
  58.        netinfo.device does not ensure that entries updated with
  59.        CMD_WRITE will be available by CMD_READ or written to permanent
  60.        store before the CMD_UPDATE is executed.
  61.  
  62. Inputs: none
  63. Results:
  64.          * io_Error contains possible error code or 0 if command was
  65.            successfull
  66.  
  67.    NI_BYNAME - search by name
  68.        Inputs:
  69.          * io_Data contains buffer for database entry. The buffer will
  70.            be filled wtih entry data upon successfull execution. The name
  71.     member of structure should be pointer to a C string containing 
  72.     the name of desired entry
  73.          * io_Length contains database len
  74.        Results:
  75.          * io_Actual contains length of the database entry
  76.          * io_Error contains possaible error code or 0 if command was
  77.            successfull
  78.  
  79.    NI_BYUID - search by ID
  80.        Inputs:
  81.          * io_Data contains buffer for database entry. The buffer will
  82.            be filled wtih entry data upon successfull execution. The ID
  83.     member of structure should be set to desired value.
  84.          * io_Length contains database len
  85.        Results:
  86.          * io_Actual contains length of the database entry
  87.          * io_Error contains possaible error code or 0 if command was
  88.            successfull
  89.    
  90.    NI_MEMBERS - find out memberships 
  91.        This command is implemented only for group unit.  It collects
  92.        the IDs of groups which have a given user as member.
  93.  
  94.        Inputs:
  95.          * io_Data is address to LONG array which is filled with group
  96.            IDs
  97.          * io_Length is the length of the array in bytes
  98.          * io_Offset is a pointer to C string containing the name of
  99.            user whose memberships are desired
  100.        Results:
  101.          * io_Actual contains length of the group ID array in bytes
  102.          * io_Error contains possaible error code or 0 if command was
  103.            successfull.
  104.  
  105. netinfo.device/group                                     netinfo.device/group
  106.  
  107.   NAME
  108.        group - format of the group permissions file
  109.  
  110.   DESCRIPTION     
  111.        The file <AmiTCP:db/group> consists of newline separated ASCII
  112.        records, one per group, containing four bar `|' separated fields.
  113.        These fields are as follows:
  114.  
  115.              group     Name of the group.
  116.              passwd    Group's encrypted password.
  117.              gid       The group's decimal ID.
  118.              member    Group members.
  119.  
  120.        The group field is the group name used for granting file access to
  121.        users who are members of the group.  The gid field is the number
  122.        associated with the group name.  They should both be unique across
  123.        the system (and often across a group of systems) since they control
  124.        file access.  The passwd field is an optional encrypted password.
  125.        This field is rarely used and an asterisk is normally placed in it
  126.        rather than leaving it blank.  The member field contains the names
  127.        of users granted the priviledges of group. The member names are
  128.        separated by commas with out spaces or newlines.  A user is
  129.        automatically in a group if that group was specified in their
  130.        AmiTCP:db/passwd entry and does not need to be added to that group
  131.        in the AmiTCP:db/group file.
  132.  
  133.   FILES
  134.        AmiTCP:db/group
  135.  
  136.   SEE ALSO
  137.        passwd
  138.  
  139.   HISTORY
  140.        A group file format appeared in Version 6 AT&T UNIX.
  141.  
  142. netinfo.device/passwd                                   netinfo.device/passwd
  143.  
  144.   NAME
  145.        passwd - format of the password file
  146.  
  147.   DESCRIPTION
  148.  
  149.        The passwd files are files consisting of newline separated records,
  150.        one per user, containing seven bar (`|') separated fields.  These
  151.        fields are as follows:
  152.  
  153.            name      User's login name.
  154.  
  155.            password  User's encrypted password.
  156.  
  157.            uid       User's id.
  158.  
  159.            gid       User's login group id.
  160.  
  161.            gecos     General information about the user.
  162.  
  163.            home_dir  User's home directory.
  164.  
  165.            shell     User's login shell.
  166.  
  167.        The name field is the login used to access the computer account, and
  168.        the uid field is the number associated with it.  They should both be
  169.        unique across the system (and often across a group of systems) since
  170.        they control file access.
  171.  
  172.        While it is possible to have multiple entries with identical login
  173.        names and/or identical user id's, it is usually a mistake to do so.
  174.        Routines that manipulate these files will often return only one of
  175.        the multiple entries, and that one by random selection.
  176.  
  177.        The login name must never begin with a hyphen (`-'); also, it is
  178.        strongly suggested that neither upper-case characters or dots (`.')
  179.        be part of the name, as this tends to confuse mailers. No field may
  180.        contain a bar (`|') as this has been used to separate the fields in
  181.        the user database.
  182.  
  183.        The password field is the encrypted form of the password. The actual
  184.        format is not restricted by netinfo.device, but usergroup.library
  185.        uses same format as Version 7 UNIX (POSIX) or 4.4BSD.  The format
  186.        used by MultiUser 1.5 or AS225r2ß is also possible, but its use is
  187.        strongly discouraged.
  188.  
  189.        If the password field is empty, no password will be required to gain
  190.        access to the machine.  This is almost invariably a mistake. Because
  191.        these files contain the encrypted user passwords, they should not be
  192.        readable by anyone without appropriate privileges.
  193.  
  194.        The group field is the group that the user will be placed in upon
  195.        login.
  196.  
  197.        The gecos field normally contains comma (`,') separated subfields as
  198.        follows:
  199.  
  200.            name           user's full name
  201.            office         user's office number
  202.            wphone         user's work phone number
  203.            hphone         user's home phone number
  204.  
  205.        This information is used by the finger program.
  206.  
  207.        The user's home directory is the full DOS path name where the user
  208.        will be placed on login.
  209.  
  210.        The shell field is the command interpreter the user prefers. If
  211.        there is nothing in the shell field, the CLI is assumed.
  212.  
  213.   FILES
  214.        AmiTCP:db/passwd
  215.  
  216.   SEE ALSO
  217.        group
  218.  
  219.   COPYRIGHT
  220.        Copyright 1980, 1991 The Regents of the University of California.
  221.        Copyright 1993, 1994 AmiTCP/IP-Group, <AmiTCP-Group@hut.fi>, 
  222.        Helsinki University of Technology, Helsinki
  223.  
  224.   HISTORY
  225.        A passwd file format appeared in Version 6 AT&T UNIX.
  226.  
  227.        The used format is basically the same as in the Multiuser Library
  228.        1.3 and AS225r2 use, except the password field.
  229.  
  230.  
  231.